Create bug_report.yml - #371
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a new GitHub issue template file Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@ISSUE_TEMPLATE/bug_report.yml`:
- Around line 1-3: Move the issue form into .github/ISSUE_TEMPLATE by
renaming/moving the file and add the required top-level description field;
specifically update the current ISSUE_TEMPLATE/bug_report.yml content (which
already contains the name: Bug Report and labels:) to include a description:
line and a proper body: array with the required form fields (e.g., textarea
entries for repro and logs) so the form validates with GitHub’s issue form
schema.
- Around line 1-3: The issue-form YAML is missing the required top-level
"description" key; update ISSUE_TEMPLATE/bug_report.yml by adding a
"description" entry immediately after the existing "name" key (e.g., name: Bug
Report then description: A short summary describing the bug and expected
behavior) so the file contains the required name, description, and body fields
per GitHub issue-form schema.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a1667d25-1072-411a-adef-a42068de996c
📒 Files selected for processing (1)
ISSUE_TEMPLATE/bug_report.yml
wscurran
left a comment
There was a problem hiding this comment.
Updated to contain all required fields and required folder "ISSUE_TEMPLATE".
* Create bug_report.yml * Update bug_report.yml
* Create bug_report.yml * Update bug_report.yml
The file at `ISSUE_TEMPLATE/bug_report.yml` (top level) was added in PR NVIDIA#371 (\`Create bug_report.yml\`) but landed in the wrong directory. GitHub only reads issue templates from \`.github/ISSUE_TEMPLATE/\`, not from a top-level \`ISSUE_TEMPLATE/\` folder, so the file has never had any effect on the issue creation flow. The four real templates (\`bug_report.yml\`, \`config.yml\`, \`doc_issue.yml\`, \`feature_request.yml\`) are correctly placed under \`.github/ISSUE_TEMPLATE/\` and continue to work. The dead file also contains a copy-paste artifact: line 2 starts with a literal \`+description:\` (the leading plus is from a stray diff fragment), so even if a user manually pointed to this file it would fail YAML schema validation. No source file or workflow references the top-level path (\`grep -r "ISSUE_TEMPLATE/bug_report"\` returns nothing), so removing it is safe. Removes the unused file and the now-empty parent directory.
This is a v1 template for managing bugs. Applies the label "status: triage"
Summary by CodeRabbit